/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.uml_generator.model;

import java.util.Map;

/**
 * base interface for all models.
 */
public interface AbstractObject
{
  /**
   * getter for the name property.
   * 
   * @return the name
   */
  public abstract String getName();



  /**
   * returns the map of {@link StereotypeModel} that mark this object.
   * 
   * @return the map of {@link StereotypeModel} that mark this object
   */
  public abstract Map<String, StereotypeModel> getStereotypes();



  /**
   * add the {@link StereotypeModel} to the model model.
   * 
   * @param stereotype
   *          the {@link StereotypeModel} to add
   */
  public abstract void addStereotype(final StereotypeModel stereotype);



  /**
   * returns wether this element is tagged with a particuliar value.
   * 
   * @param tag
   *          the value to check.
   * @return <code>true</code> if an only if the element is tagged with the
   *         value.
   */
  public boolean hasStereotype(String tag);



  /**
   * returns the value of the given tag for the given element. Will return
   * <code>null</code> if the element is not tagged with the given tag.
   * 
   * @param stereotypeName
   *          the value to check.
   * @return the value of the given tag for the given element
   */
  public StereotypeModel getStereotype(String stereotypeName);



  /**
   * setter for the name property.
   * 
   * @param name
   *          the name to set
   */
  public abstract void setName(String name);



  /**
   * getter for the id property.
   * 
   * @return the id
   */
  public abstract String getUmlId();



  /**
   * setter for the id property.
   * 
   * @param umlId
   *          the id to set
   */
  public abstract void setUmlId(String umlId);



  /**
   * getter for the length property.
   * 
   * @return the length
   */
  public abstract Integer getLength();



  /**
   * returns the comment associated to the object.
   * 
   * @return the comment associated to the object
   */
  public abstract String getComment();



  /**
   * set the comment associated to the object.
   * 
   * @param comment
   *          the comment associated to the object.
   */
  public abstract void setComment(String comment);



  /**
   * returns the original object if the current object is decorated.
   * 
   * @return the original object if the current object is decorated
   */
  public abstract AbstractObject getUndecoraredObject();
}
